home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / X11 / wais / doc / wais.el.txt < prev    next >
Lisp/Scheme  |  1995-05-09  |  5KB  |  134 lines
  1. wais.el - GNU Emacs interface to WAIS
  2.  
  3. wais.el is a GNU emacs lisp file that allows people to use WAIS through
  4. GNU Emacs.  It relies on the WAIS version 8 distribution, particularly on a
  5. shell program called waisq.
  6.  
  7. wais.el has a number of configuration variables that must be set properly
  8. at a site upon installation of the WAIS software.
  9.  
  10. (defvar *wais-top-directory* "/proj/wais/wais/")
  11. (defvar waisq-program (concat *wais-top-directory* "bin/waisq")
  12.   "Location of the waisq executable. 
  13.    This comes in the bin directory of the wais release") 
  14. (defvar waisindex-program (concat *wais-top-directory* "bin/waisindex")
  15.   "Location of the waisindex executable. 
  16.    This comes in the bin directory of the wais release")
  17. (defvar *common-source-directory* (concat *wais-top-directory* "wais-sources/")
  18.   "Where the common sources for you site live.  nil if there are none")
  19.  
  20. (defvar *wais-question-directory* "~/wais-questions/")
  21. (defvar *wais-source-directory* "~/wais-sources/")
  22. (defvar *wais-document-directory* "~/wais-documents/")
  23. (defvar wais-tmp-directory "/tmp/")
  24. (defvar wais-version 8)
  25.  
  26. The first four variables are site specififc, and should be modified
  27. according to your site.
  28.  
  29. The GNU Emacs interface to WAIS (refered to as wais-gmacs from now on) is
  30. based on the WAIS Station built for the Apple Macintosh, and xwais, which
  31. you'll find in this distribution.  To a very large degree the applications
  32. can be used interchangably, as they all use the same basic file structure.
  33.  
  34. The principle functions in wais-gmacs are:
  35.  
  36. wais:
  37.  Find a wais question and go to it.
  38.  First tries to find the question named Quick, then any wais question,
  39.  finally it creates a Quick question, prompting for search words and source.
  40.  
  41. wais-select-question:
  42.  Make a menu of questions so you can select one.  
  43.  Type ? after invocation to get help on commands available.
  44.  Type q immediately to make the question menu go away.
  45.  
  46. wais-select-source:
  47.  Make a menu of sources so you can select one.  
  48.  Type ? after invocation to get help on commands available.
  49.  Type q immediately to make the source menu go away.
  50.  
  51. wais-create-question:
  52.  Create a new Question named NAME
  53.  
  54. wais-create-source:
  55.  Create a new Source and a database to go with it
  56.  
  57. wais-novice:
  58. Create and run the 'Quick' novice question, and pop up
  59. the novice Help
  60.  
  61. There are three new "modes" created by gmacs-wais:
  62.  
  63. 1. waisq-mode
  64. 2. waisk-mode
  65. 3. waisd-mode
  66.  
  67. Each mode has some special keybindings associated with it.
  68.  
  69. waisq-mode is the pricipal mode for manipulating WAIS questions.  The
  70. keybindings for waisq-mode are:
  71.  
  72.    Movement commands:
  73.  
  74.    C-n     Move to next document, or arg documents.
  75.    C-p     Move to previous document, or arg documents.
  76.    e,f,v   Edit, Find or View the current document (all are synonymous).
  77.    n       Edit to next document, or arg documents.
  78.    p       Edit to previous document, or arg documents.
  79.    space   Scroll document in other window forward.
  80.    delete  Scroll document backward.
  81.    B       Go to the best line in the document
  82.    C-l     Refresh Display and reset Question Window.
  83.  
  84.    Sources:
  85.  
  86.    A       Add a source to the question.
  87.    D       Delete all sources from the question.
  88.  
  89.    Relevance Feedback:
  90.  
  91.    a       Add the current document to the question.
  92.    d       Delete all relevant documents from the question.
  93.  
  94.    Action Commands:
  95.  
  96.    k       Replace the 'Find documents on' words
  97.    G,RET   Go for it (submit the query).
  98.    N       Make a new question.
  99.    m       Toggle multiple document buffer mode. 
  100.    s       Select another question.
  101.    S       Save this document to a file.
  102.    ? or h  Show this message (Help).
  103.    q       quit WaisQ, but keep the question's buffer.
  104.    Q       Quit WaisQ and kill this question's buffer.
  105.  
  106. waisd-mode is the principal mode for viewing WAIS documents, as retrieved
  107. through a WAIS question.  The keybindings for waisd-mode are:
  108.  
  109.    Movement commands:
  110.  
  111.    All the usual text-mode cursor movement work.
  112.    In addition the following commands are available:
  113.  
  114.    B       Go to the best line in the document
  115.    space   Scroll document forward.
  116.    delete  Scroll document backward.
  117.  
  118.    Action Commands:
  119.  
  120.    s       Add the marked region as a section to the Relevant Documents.
  121.    ? or h  Show this message (Help).
  122.    q       quit WaisQ, but keep the question's buffer.
  123.    Q       Quit WaisQ and kill this question's buffer.
  124.  
  125. waisk-mode is the same as text-mode, but pressing RETURN will initiated the
  126. search.
  127.  
  128. Some notes on retrieving and saving sources (from the directory of servers,
  129. or from the help query):
  130.  
  131. If you use the S (capital-S, Save document to file) on a source, it will
  132. prompt for the name of the source file, and automatically add the .src if
  133. necessary.
  134.